home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 015a / batmn21e.zip / TRACY.DOC < prev    next >
Text File  |  1990-11-20  |  6KB  |  147 lines
  1.  
  2.     │
  3.     │  T R A C Y   2 . 1 e
  4.     │
  5.     │  - interactive debugger
  6.     │    for Batman
  7.     │
  8.     │  Thor Ivar Ekle 1990
  9.     │
  10.  
  11.  
  12.  
  13.  
  14.     WHAT IS TRACY?
  15.     ──────────────
  16.  
  17.     Tracy is a so-called interactive debugger for the batch file compiler
  18.     Batman. With Tracy you can run the program files produced by Batman one
  19.     line at a time, while viewing the contents of variables and parameters.
  20.     Tracy makes it a lot easier to track down errors in program files.
  21.  
  22.     Any questions regarding Batman or Tracy? Call me at +47-7-518612.
  23.  
  24.  
  25.  
  26.     USING TRACY
  27.     ───────────
  28.  
  29.     Tracy version 2.1e should be used together with Batman version 2.1e.
  30.     The command for starting the program is:
  31.  
  32.         TRACY [/S] <program file> [<parameters>]
  33.  
  34.     The parameter <program file> is the name of the .BAT-file you wish to
  35.     debug. It must already be compiled with Batman, and in order to able to
  36.     debug it with Tracy, you must use the Batman /D option.
  37.  
  38.     Any parameters for the batch file should be appended to the command.
  39.     You can include up to 9 parameters.
  40.  
  41.     On some old colors monitors you might see some "snow" when the screen
  42.     is being updated. Use the /S option to prevent this. This will lead to
  43.     slower execution of Tracy, however.
  44.  
  45.     Tracy needs these files in order to be able to run a program file:
  46.  
  47.         filename.BAT  - the batch file
  48.         filename.EXE  - the compiled program file
  49.         filename.DIK  - debug information
  50.  
  51.     These must also reside in the same directory. This does not have to be
  52.     the current directory.
  53.  
  54.  
  55.  
  56.     THE SCREEN
  57.     ──────────
  58.  
  59.     When Tracy is ready for use, the screen will look something like this:
  60.  
  61.  
  62.     ┌─────────────────────────────────────────────────────────────────────┐
  63.     │  TRACY 2.1e                                    Thor Ivar Ekle 1990  │
  64.     │     Line 8                                               385 kB     │
  65.     ├─────────────────────────────────────────────────────────────────────┤
  66.     │rem                                                                  │
  67.     │rem   This is a demonstration of the MENU command in Batman.         │
  68.     │rem   The commands for the menu items might need editing, even if    │
  69.     │rem   the called programs are stored in DOS' path.                   │
  70.     │rem                                                                  │
  71.     │                                                                     │
  72.     │:main_menu                                                           │
  73.     │color 7 1                                                            │
  74.     │cls                                                                  │
  75.     │color 0 7                                                            │
  76.     │xy 1 1                                                               │
  77.     │clreol                                                               │
  78.     │echo "   BATDEMO 1.8"                                                │
  79.     │xy 1 25                                                              │
  80.     ├─────────────────────────────────────────────────────────────────────┤
  81.     │0: C:\TPOO\SOURCE\BATMAN\BATDEMO.EXE                                 │
  82.     │                                                                     │
  83.     │                                                                     │
  84.     │                                                                     │
  85.     │                                                                     │
  86.     ├─────────────────────────────────────────────────────────────────────┤
  87.     │  C:\TPOO\SOURCE\BATMAN\BATDEMO.BAT                                  │
  88.     └─────────────────────────────────────────────────────────────────────┘
  89.  
  90.  
  91.     The top line displays the name of the program, version number and
  92.     author, and below this the current line number and the amount of free
  93.     memory is shown.
  94.  
  95.     The upper window shows part of the batch file. The current program line
  96.     is highlighted.
  97.  
  98.     Below this is another window, where the parameters (%0 - %9), the
  99.     variables (%%A - %%Z) and DOS environment variables are shown. At the
  100.     bottom line the name of the program file is displayed.
  101.  
  102.  
  103.  
  104.     FUNCTIONS
  105.     ─────────
  106.  
  107.     These functions are available in Tracy:
  108.  
  109.         <SPACE>    - executes the highlighted line.
  110.  
  111.         TAB        - shows you what the program has printed on the screen,
  112.                      if anything. Press TAB again to return to Tracy's
  113.                      screen.
  114.  
  115.         <UP>       - scrolls the list of parameters and variables up one
  116.                      line.
  117.  
  118.         <DOWN>     - scrolls the list down one line.
  119.  
  120.         ALT + A    - starts automatic execution of the program. Execution
  121.                      continues until a key is pressed.
  122.  
  123.         ESC        - aborts the debugging.
  124.  
  125.     When the program terminates, a message is displayed that reports the
  126.     errorlevel with which the program terminated. When you see this
  127.     message, you may press:
  128.  
  129.         RETURN     - start the program over.
  130.  
  131.         ESC        - return to DOS.
  132.  
  133.     Apart from <SPACE> and ALT + A, you can also use the keys listed above.
  134.  
  135.     The same applies when debugging is aborted with Esc. Tracy will display
  136.     a message which says that the program has been aborted, and you can
  137.     press Return or Esc.
  138.  
  139.  
  140.  
  141.     FINAL WORDS
  142.     ───────────
  143.  
  144.     I hope you find Batman useful. Suggestions for improvements and bug
  145.     reports are welcomed.
  146.  
  147.